home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 001a / sendcomm.zip / READCOM.DOC < prev    next >
Text File  |  1991-10-06  |  5KB  |  126 lines
  1.  
  2.  
  3.         ReadCom
  4.  
  5.         A PCBoard 14.5 Utility
  6.         Donated into the Public Domain
  7.         By Mark Herring
  8.  
  9.         ────────────────────────────────────────────────────────────────
  10.  
  11.         ReadCom is a little utility that will let a caller enter text
  12.         and will load this entry into a DOS environment variable.
  13.         ReadCom, when used with our SendCom utility, lets you create
  14.         simple "doors".
  15.  
  16.         ReadCom understands PCBoard @x color codes and also translates
  17.         many (but not all) @variables if you include a prompt string.
  18.  
  19.         Syntax:
  20.  
  21.         READCOM ['prompt string'] environment variable [/U] [/F] [/L:nn]
  22.  
  23.         'prompt string' is optional and if used this text is transmitted
  24.         to the caller before they can enter a response.  You must
  25.         enclose prompts within single quote marks.
  26.  
  27.           These PCBoard 14.5 @variables are supported by READCOM:
  28.  
  29.                   @Xnn             PCBoard color codes
  30.                   @CLS@            Clears the screen
  31.                   @FIRST@          Caller's first name
  32.                   @USER@           Caller's full name
  33.                   @BPS@            Connect baud rate
  34.                   @NODE@           Node number
  35.                   @SYSDATE@        Current system date
  36.                   @SYSTIME@        Current system time
  37.  
  38.           If USERS.SYS is also found in the current subdirectory then
  39.           these @variables are also supported by READCOM:
  40.  
  41.                   @firstu@         First Name (all caps)
  42.                   @city@           City
  43.                   @password@       Password
  44.                   @security@       Security Level
  45.                   @confnum@        Current conference number
  46.                   @dataphone@      Business/Data Phone
  47.                   @homephone@      Home/Voice Phone
  48.                   @msgleft@        Number of Messages Written
  49.                   @msgread@        Number of Messages Read
  50.                   @numtimeson@     Number of Times On
  51.                   @proltr@         Default Protocol Letter
  52.                   @timeused@       Time Used
  53.                   @upbytes@        Total U/L Bytes
  54.                   @upfiles@        Total U/L Files
  55.                   @dlbytes@        Total D/L Bytes
  56.                   @dlfiles@        Total D/L Files
  57.  
  58.           READCOM also interprets CONTROL sequences too.  For example,
  59.           "^G" will produce a beep on the caller's terminal.   READCOM
  60.           also will replace any %VARIABLE% statement with the contents
  61.           of the DOS environment variable "VARIABLE".
  62.  
  63.         "environment variable" is the name of a DOS environment variable
  64.         that you wish to load with the value entered by the caller.
  65.         You do not need to create this variable before calling READCOM.
  66.         READCOM will create it for you.
  67.  
  68.         "/U", if used, forces all input to UPPER case.
  69.  
  70.         "/F", if used, will also create a file named READCOM.$$$ that
  71.         contains the value entered by the caller.  This option is
  72.         provided to programmers who wish to SHELL to READCOM in order to
  73.         get input from the caller.  You do not need to specify a DOS
  74.         environment variable if you use this option.
  75.  
  76.         "/L:nn" tells READCOM the maximum size of the data entry field.
  77.         If this option is not specified then READCOM uses the current
  78.         size of the DOS environment variable.  Please note that if you
  79.         use "/F" then you must enter the maximum length allowed.
  80.         
  81.         ReadCom requires PCBOARD.SYS in order to find the communications
  82.         port address.  If comport value is ZERO then READCOM will
  83.         attempt to open PCBOARD.DAT and find the comport address in this
  84.         file.
  85.  
  86.         If carrier was lost then READCOM will set the DOS environment
  87.         variable to "!".  You can check for this value and if found you
  88.         will know that the carrier was lost.  READCOM also sets the DOS
  89.         error level to ONE if the program if carrier was lost.
  90.  
  91.  
  92.  
  93.         Registration and support:
  94.  
  95.         None needed.  This program is donated into the public domain for
  96.         all to use.  We've found it to be handy to use on our own
  97.         system.  But we cannot guarantee that READCOM will work with
  98.         your system.
  99.  
  100.         Instead of a registration fee, we request that if you are "in
  101.         the market" for an offline mail door system (Qmail Door), a
  102.         network mail handler (QNet), offline mail reader (Qmail DeLuxe²),
  103.         a fax gateway (PCB/FaxMail) or alphanumeric pager gateway (Pager)
  104.         or finally, a PCBoard/Usenet gateway (PCB/Usenet), please
  105.         consider purchasing one of our products.
  106.  
  107.         I ask that if you do use READCOM that you leave a message
  108.         addressed to me on either our support system or SALT AIR telling
  109.         us how you are using it.  I'm always interested in how our
  110.         systems are being used!
  111.  
  112.         Thanks to all who have supported us in the past - we look
  113.         forward to serving your needs in the future!
  114.  
  115.  
  116.                                 Sparky
  117.  
  118.  
  119.         Sparkware
  120.         Post Office Box 605
  121.         Cordova, Tennessee   38018
  122.  
  123.            BBS: (901) 382-5583
  124.         Office: (901) 373-MAIL
  125.  
  126.